   
USER MANUAL WETSPA_ANALYSIS_TOOL.xls v1.03
-------------------------------------------


Developed by Jiri Nossent
Dept. of Hydrology and Hydraulic Engineering
Vrije Universiteit Brussel
Pleinlaan 2, 1050 Brussels, Belgium
tel: x-32-2-6293036, fax: x-32-2-6293022
mailto: jnossent@vub.ac.be
http://student.vub.ac.be/~jnossent

PhD project - 2006
Promotor: Prof. PhD. Ir. W. Bauwens
		
 
_______________________________________________________________________________________


CONTENTS:
---------

1) When to use this tool?

2) How to install?

3) The update-buttons
	3a) UPDATE ALL SHEETS
	3b) CLEAR ALL SHEETS
	3c) UPDATE MEAN
	3d) UPDATE UH_CELL_H
	3e) UPDATE UH_SUB_H
	3f) UPDATE UH_WATERSHED
	3g) UPDATE UH_CELL_S
	3h) UPDATE UH_SUB_S
	3i) UPDATE UH_RIVER
	3j) UPDATE Q_TOT
	3k) UPDATE BALANCE
	3l) UPDATE Q_SUB
	3m) UPDATE EVALUATION
	3n) UPDATE Q_M
	3o) UPDATE Q_eval

4) The Worksheets
	4a) MAIN 
	4b) MEAN
	4c) UH_CELL_H
	4d) UH_SUB_H
	4e) UH_WATERSHED
	4f) UH_CELL_S
	4g) UH_SUB_S
	4h) UH_RIVER
	4i) Q_TOT
	4j) BALANCE
	4k) Q_SUB
	4l) EVALUATION
	4m) Q_M
	4n) Q_eval
	4o) sequential
	4p) LN(sequential)
	4q) ranked
	4r) LN(ranked)
	4s) residues
	4t) LN(residues)
	4u) trend
	4v) LN(trend)


_______________________________________________________________________________________


1) WHEN TO USE THIS TOOL?
-------------------------

This tool was developed in an attempt to make the calibration and validation process of
simulations in WETSPA more user friendly.

Most of the WETSPA output-files are *.txt-files and it might be time consuming to
update the excel-sheet that you are using for the analysis. With a push on the buttons
you can easily update all the sheets in just a few seconds.

Sheets 2 until 11 (MEAN --> EVALUATION) in WETSPA_ANALYSIS_TOOL.xls have the same name
as the *.txt-files that you can find in the '...\model\output'-folder.

Sheets 12 until 21 (Q_M --> LN(trend)) are inserted to help you analyze your results.

Don't forget that when you update a sheet, you will lose the information that was
previously stored on that sheet! You might need to save it with another name (e.g. by
copying the whole sheet).

This goes for your WETSPA *.txt-files to, since you will lose the information of a
previous run when you run one of the executables.

_______________________________________________________________________________________


2) HOW TO INSTALL?
------------------

Very easy, just copy the WETSPA_ANALYSIS_TOOL.xls in the zipped file to the location on
your hard drive where you have the output-files, '...\model\output'.

When you open the xls-file, there will probably appear a pop-up:

	"...\WETSPA_ANALYSIS_TOOL.xls contains macros"

	"Macros may contain viruses. It is usually safe to disable macros, but if the
	 macros are legitimate, you might lose some functionality."

Please push the "Enable Macros"-button, or the TOOL won't work!

You will need to adapt the code just a little to make sure you the TOOL works:

	* Go to the "Tools"-menu, and select "Macro". Here you have to select "Visual
	  Basic Editor".

	* In the upper left window ("Project - VBAProject"), double-click on the 
	  "Modules"-folder, if it isn't opened. Then double-click on "Module1". A 
	  window will open up on your right hand side (if it wasn't opened already).
	  In this window you will find the visual basic code of the tool.

	* Go to the "Edit"-menu, and select "Replace" or push "ctrl+H". Replace 
	  "C:\wetspa_model\model\" by the pathname where you find your "input"- and
	  "output"-folder ("C:\...\model\"). (this will have to be changed 14 times)


_______________________________________________________________________________________

3) THE UPDATE-BUTTONS
---------------------

Most of the update buttons speak for themselves. We will give just a little explanation
on all of them. The buttons are grouped in the same way as the output-files are
generated by the executables.


	3a) UPDATE ALL SHEETS
	    -----------------
	    Pushing this button will have the same effect as pushing buttons "3c)" till
	    "3o)".


	3b) CLEAR ALL SHEETS
	    ----------------
	    This will clear all sheets 2 until 13 (MEAN --> Q_eval).


	3c) UPDATE MEAN
	    -----------
	    This will update the "MEAN"-sheet with the information from the mean.txt
	    output-file.

	3d) UPDATE UH_CELL_H
	    ----------------
	    This will update the "UH_CELL_H"-sheet with the information from the 
	    uh_cell_h.txt output-file.

	3e) UPDATE UH_SUB_H
	    ---------------
	    This will update the "UH_SUB_H"-sheet with the information from the 
	    uh_sub_h.txt output-file.

	3f) UPDATE UH_WATERSHED
	    -------------------
	    This will update the "UH_WATERSHED"-sheet with the information from the 
	    uh_watershed.txt output-file.

	3g) UPDATE UH_CELL_S
	    ----------------
	    This will update the "UH_CELL_S"-sheet with the information from the 
	    uh_cell_S.txt output-file.

	3h) UPDATE UH_SUB_S
	    ---------------
	    This will update the "UH_SUB_S"-sheet with the information from the 
	    uh_sub_S.txt output-file.

	3i) UPDATE UH_RIVER
	    ---------------
	    This will update the "UH_RIVER"-sheet with the information from the 
	    uh_river.txt output-file.

	3j) UPDATE Q_TOT
	    ------------
	    This will update the "Q_TOT"-sheet with the information from the q_tot.txt
	    output-file.

	3k) UPDATE BALANCE
	    --------------
	    This will update the "BALANCE"-sheet with the information from the 
	    balance.txt output-file.

	3l) UPDATE Q_SUB
	    ------------
	    This will update the "Q_SUB"-sheet with the information from the q_sub.txt
	    output-file.

	3m) UPDATE EVALUATION
	    -----------------
	    This will update the "EVALUATION"-sheet with the information from the 
	    evaluation.txt output-file.

	3n) UPDATE Q_M
	    ----------
	    This will update the "Q_M"-sheet with the information from the q.txt
	    input-file.

	3o) UPDATE Q_eval
	    -------------
	    This will update the "Q_eval"-sheet and all the graphs with the information
	    from the previous sheets.


_______________________________________________________________________________________

4) THE WORKSHEETS
---------------------

Most of the names of the worksheets speak for themselves. We will give just a little 
explanation on all of them. Please read the WETSPA manual for more information.


	4a) MAIN
	    ----
	    Here you can find the buttons needed to update and clear the Worksheets.


	4b) MEAN
	    ----
	    Here you will find the information from the mean.txt output-file.

	4c) UH_CELL_H
	    ---------
	    Here you will find the information from the uh_cell_h.txt output-file.

	4d) UH_SUB_H
	    --------
	    Here you will find the information from the uh_sub_h.txt output-file.

	4e) UH_WATERSHED
	    ------------
	    Here you will find the information from the uh_watershed.txt output-file.

	4f) UH_CELL_S
	    ---------
	    Here you will find the information from the uh_cell_S.txt output-file.

	4g) UH_SUB_S
	    --------
	    Here you will find the information from the uh_sub_S.txt output-file.

	4h) UH_RIVER
	    --------
	    Here you will find the information from the uh_river.txt output-file.

	4i) Q_TOT
	    -----
	    Here you will find the information from the q_tot.txt output-file.

	4j) BALANCE
	    -------
	    Here you will find the information from the balance.txt output-file.

	4k) Q_SUB
	    -----
	    Here you will find the information from the q_sub.txt output-file.

	4l) EVALUATION
	    ----------
	    Here you will find the information from the evaluation.txt output-file.

	4m) Q_M
	    ---
	    Here you will find the information from the q.txt input-file.

	4n) Q_eval
	    ------
	    Here you will find an analysis sheet, with observations, model results
	    and object functions (NSE, ranked NSE,...).

	4o) sequential
	    ----------
	    Graph with observed and modeled discharges.

	4p) LN(sequential)
	    --------------
	    Graph with the log transformed (observed and modeled) discharges. (Gives
	    better calibration results for low discharges.)

	4q) ranked
	    ------
	    Graph with ranked (observed and modeled) discharges.

	4r) LN(ranked)
	    ----------
	    Graph with log transformed ranked (observed and modeled) discharges.

	4s) residues
	    --------
	    Graph with residues (observed - modeled) of the discharges against time.

	4t) LN(residues)
	    ------------
	    Graph with residues (observed - modeled) of the log transformed discharges
	    against time.

	4u) trend
	    -----
	    Graph with residues (observed - modeled) of the discharges against 
	    observed discharges.

	4v) LN(trend)
	    ---------
	    Graph with residues (observed - modeled) of the log transformed discharges
	    against observed discharges.

_______________________________________________________________________________________
